﻿<!DOCTYPE html>
<!--[if IE]><![endif]-->
<html>
  
  <head>
    <meta charset="utf-8">
    <meta http-equiv="X-UA-Compatible" content="IE=edge,chrome=1">
    <title>Class HatchBoundaryPath
   </title>
    <meta name="viewport" content="width=device-width">
    <meta name="title" content="Class HatchBoundaryPath
   ">
    <meta name="generator" content="docfx 2.56.4.0">
    
    <link rel="shortcut icon" href="../favicon.ico">
    <link rel="stylesheet" href="../styles/docfx.vendor.css">
    <link rel="stylesheet" href="../styles/docfx.css">
    <link rel="stylesheet" href="../styles/main.css">
    <meta property="docfx:navrel" content="../toc.html">
    <meta property="docfx:tocrel" content="toc.html">
    
    
    
  </head>
  <body data-spy="scroll" data-target="#affix" data-offset="120">
    <div id="wrapper">
      <header>
        
        <nav id="autocollapse" class="navbar navbar-inverse ng-scope" role="navigation">
          <div class="container">
            <div class="navbar-header">
              <button type="button" class="navbar-toggle" data-toggle="collapse" data-target="#navbar">
                <span class="sr-only">Toggle navigation</span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
                <span class="icon-bar"></span>
              </button>
              
              <a class="navbar-brand" href="../index.html">
                <img id="logo" class="svg" src="../logo.svg" alt="">
              </a>
            </div>
            <div class="collapse navbar-collapse" id="navbar">
              <form class="navbar-form navbar-right" role="search" id="search">
                <div class="form-group">
                  <input type="text" class="form-control" id="search-query" placeholder="Search" autocomplete="off">
                </div>
              </form>
            </div>
          </div>
        </nav>
        
        <div class="subnav navbar navbar-default">
          <div class="container hide-when-search" id="breadcrumb">
            <ul class="breadcrumb">
              <li></li>
            </ul>
          </div>
        </div>
      </header>
      <div role="main" class="container body-content hide-when-search">
        
        <div class="sidenav hide-when-search">
          <a class="btn toc-toggle collapse" data-toggle="collapse" href="#sidetoggle" aria-expanded="false" aria-controls="sidetoggle">Show / Hide Table of Contents</a>
          <div class="sidetoggle collapse" id="sidetoggle">
            <div id="sidetoc"></div>
          </div>
        </div>
        <div class="article row grid-right">
          <div class="col-md-10">
            <article class="content wrap" id="_content" data-uid="netDxf.Entities.HatchBoundaryPath">
  
  
  <h1 id="netDxf_Entities_HatchBoundaryPath" data-uid="netDxf.Entities.HatchBoundaryPath" class="text-break">Class HatchBoundaryPath
  </h1>
  <div class="markdown level0 summary"><p>Represent a loop of a <a class="xref" href="netDxf.Entities.Hatch.html">Hatch</a> boundaries.</p>
</div>
  <div class="markdown level0 conceptual"></div>
  <div class="inheritance">
    <h5>Inheritance</h5>
    <div class="level0"><span class="xref">System.Object</span></div>
    <div class="level1"><span class="xref">HatchBoundaryPath</span></div>
  </div>
  <div classs="implements">
    <h5>Implements</h5>
    <div><span class="xref">System.ICloneable</span></div>
  </div>
  <div class="inheritedMembers">
    <h5>Inherited Members</h5>
    <div>
      <span class="xref">System.Object.Equals(System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.Equals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.GetHashCode()</span>
    </div>
    <div>
      <span class="xref">System.Object.GetType()</span>
    </div>
    <div>
      <span class="xref">System.Object.MemberwiseClone()</span>
    </div>
    <div>
      <span class="xref">System.Object.ReferenceEquals(System.Object, System.Object)</span>
    </div>
    <div>
      <span class="xref">System.Object.ToString()</span>
    </div>
  </div>
  <h6><strong>Namespace</strong>: <a class="xref" href="netDxf.Entities.html">netDxf.Entities</a></h6>
  <h6><strong>Assembly</strong>: CADability.dll</h6>
  <h5 id="netDxf_Entities_HatchBoundaryPath_syntax">Syntax</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public class HatchBoundaryPath : ICloneable</code></pre>
  </div>
  <h5 id="netDxf_Entities_HatchBoundaryPath_remarks"><strong>Remarks</strong></h5>
  <div class="markdown level0 remarks"><p>The entities that make a loop can be any combination of lines, light weight polylines, polylines, circles, arcs, ellipses, and splines.<br>
The entities that define a loop should define a closed path, they have to be on the same plane as the hatch, and with the same normal;
if these conditions are not met the result might be unpredictable. <br>
Entities expressed in 3d coordinates like lines, polylines, and splines will be projected into its local plane.
All edges that make a HatchBoundaryPath are 2d objects, only have X and Y coordinates.
This is why to avoid unexpected results is important that all entities that define the paths have the same normal, same reference plane.</p>
</div>
  <h3 id="constructors">Constructors
  </h3>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/SOFAgh/CADability/new/master/apiSpec/new?filename=netDxf_Entities_HatchBoundaryPath__ctor_System_Collections_Generic_IEnumerable_netDxf_Entities_EntityObject__.md&amp;value=---%0Auid%3A%20netDxf.Entities.HatchBoundaryPath.%23ctor(System.Collections.Generic.IEnumerable%7BnetDxf.Entities.EntityObject%7D)%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/SOFAgh/CADability/blob/master/CADability/DXF/Entities/HatchBoundaryPath.cs/#L667">View Source</a>
  </span>
  <a id="netDxf_Entities_HatchBoundaryPath__ctor_" data-uid="netDxf.Entities.HatchBoundaryPath.#ctor*"></a>
  <h4 id="netDxf_Entities_HatchBoundaryPath__ctor_System_Collections_Generic_IEnumerable_netDxf_Entities_EntityObject__" data-uid="netDxf.Entities.HatchBoundaryPath.#ctor(System.Collections.Generic.IEnumerable{netDxf.Entities.EntityObject})">HatchBoundaryPath(IEnumerable&lt;EntityObject&gt;)</h4>
  <div class="markdown level1 summary"><p>Initializes a new instance of the <code>Hatch</code> class.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public HatchBoundaryPath(IEnumerable&lt;EntityObject&gt; edges)</code></pre>
  </div>
  <h5 class="parameters">Parameters</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Name</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Collections.Generic.IEnumerable</span>&lt;<a class="xref" href="netDxf.Entities.EntityObject.html">EntityObject</a>&gt;</td>
        <td><span class="parametername">edges</span></td>
        <td><p>List of entities that makes a loop for the hatch boundary paths.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h3 id="properties">Properties
  </h3>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/SOFAgh/CADability/new/master/apiSpec/new?filename=netDxf_Entities_HatchBoundaryPath_Edges.md&amp;value=---%0Auid%3A%20netDxf.Entities.HatchBoundaryPath.Edges%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/SOFAgh/CADability/blob/master/CADability/DXF/Entities/HatchBoundaryPath.cs/#L708">View Source</a>
  </span>
  <a id="netDxf_Entities_HatchBoundaryPath_Edges_" data-uid="netDxf.Entities.HatchBoundaryPath.Edges*"></a>
  <h4 id="netDxf_Entities_HatchBoundaryPath_Edges" data-uid="netDxf.Entities.HatchBoundaryPath.Edges">Edges</h4>
  <div class="markdown level1 summary"><p>Gets the list of entities that makes a loop for the hatch boundary paths.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public IReadOnlyList&lt;HatchBoundaryPath.Edge&gt; Edges { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Collections.Generic.IReadOnlyList</span>&lt;<a class="xref" href="netDxf.Entities.HatchBoundaryPath.Edge.html">HatchBoundaryPath.Edge</a>&gt;</td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/SOFAgh/CADability/new/master/apiSpec/new?filename=netDxf_Entities_HatchBoundaryPath_Entities.md&amp;value=---%0Auid%3A%20netDxf.Entities.HatchBoundaryPath.Entities%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/SOFAgh/CADability/blob/master/CADability/DXF/Entities/HatchBoundaryPath.cs/#L726">View Source</a>
  </span>
  <a id="netDxf_Entities_HatchBoundaryPath_Entities_" data-uid="netDxf.Entities.HatchBoundaryPath.Entities*"></a>
  <h4 id="netDxf_Entities_HatchBoundaryPath_Entities" data-uid="netDxf.Entities.HatchBoundaryPath.Entities">Entities</h4>
  <div class="markdown level1 summary"><p>Gets the list of entities that makes the boundary.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public IReadOnlyList&lt;EntityObject&gt; Entities { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Collections.Generic.IReadOnlyList</span>&lt;<a class="xref" href="netDxf.Entities.EntityObject.html">EntityObject</a>&gt;</td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h5 id="netDxf_Entities_HatchBoundaryPath_Entities_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>If the boundary path belongs to a non-associative hatch this list will contain zero entities.</p>
</div>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/SOFAgh/CADability/new/master/apiSpec/new?filename=netDxf_Entities_HatchBoundaryPath_PathType.md&amp;value=---%0Auid%3A%20netDxf.Entities.HatchBoundaryPath.PathType%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/SOFAgh/CADability/blob/master/CADability/DXF/Entities/HatchBoundaryPath.cs/#L716">View Source</a>
  </span>
  <a id="netDxf_Entities_HatchBoundaryPath_PathType_" data-uid="netDxf.Entities.HatchBoundaryPath.PathType*"></a>
  <h4 id="netDxf_Entities_HatchBoundaryPath_PathType" data-uid="netDxf.Entities.HatchBoundaryPath.PathType">PathType</h4>
  <div class="markdown level1 summary"><p>Gets the boundary path type flag.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public HatchBoundaryPathTypeFlags PathType { get; }</code></pre>
  </div>
  <h5 class="propertyValue">Property Value</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><a class="xref" href="netDxf.Entities.HatchBoundaryPathTypeFlags.html">HatchBoundaryPathTypeFlags</a></td>
        <td></td>
      </tr>
    </tbody>
  </table>
  <h3 id="methods">Methods
  </h3>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/SOFAgh/CADability/new/master/apiSpec/new?filename=netDxf_Entities_HatchBoundaryPath_Clone.md&amp;value=---%0Auid%3A%20netDxf.Entities.HatchBoundaryPath.Clone%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/SOFAgh/CADability/blob/master/CADability/DXF/Entities/HatchBoundaryPath.cs/#L841">View Source</a>
  </span>
  <a id="netDxf_Entities_HatchBoundaryPath_Clone_" data-uid="netDxf.Entities.HatchBoundaryPath.Clone*"></a>
  <h4 id="netDxf_Entities_HatchBoundaryPath_Clone" data-uid="netDxf.Entities.HatchBoundaryPath.Clone">Clone()</h4>
  <div class="markdown level1 summary"><p>Creates a new HatchBoundaryPath that is a copy of the current instance.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public object Clone()</code></pre>
  </div>
  <h5 class="returns">Returns</h5>
  <table class="table table-bordered table-striped table-condensed">
    <thead>
      <tr>
        <th>Type</th>
        <th>Description</th>
      </tr>
    </thead>
    <tbody>
      <tr>
        <td><span class="xref">System.Object</span></td>
        <td><p>A new HatchBoundaryPath that is a copy of this instance.</p>
</td>
      </tr>
    </tbody>
  </table>
  <h5 id="netDxf_Entities_HatchBoundaryPath_Clone_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>When cloning a HatchBoundaryPath, if it has entities that defines its contour, they will not be cloned.</p>
</div>
  <span class="small pull-right mobile-hide">
    <span class="divider">|</span>
    <a href="https://github.com/SOFAgh/CADability/new/master/apiSpec/new?filename=netDxf_Entities_HatchBoundaryPath_Update.md&amp;value=---%0Auid%3A%20netDxf.Entities.HatchBoundaryPath.Update%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A">Improve this Doc</a>
  </span>
  <span class="small pull-right mobile-hide">
    <a href="https://github.com/SOFAgh/CADability/blob/master/CADability/DXF/Entities/HatchBoundaryPath.cs/#L761">View Source</a>
  </span>
  <a id="netDxf_Entities_HatchBoundaryPath_Update_" data-uid="netDxf.Entities.HatchBoundaryPath.Update*"></a>
  <h4 id="netDxf_Entities_HatchBoundaryPath_Update" data-uid="netDxf.Entities.HatchBoundaryPath.Update">Update()</h4>
  <div class="markdown level1 summary"><p>Updates the internal HatchBoundaryPath data.</p>
</div>
  <div class="markdown level1 conceptual"></div>
  <h5 class="decalaration">Declaration</h5>
  <div class="codewrapper">
    <pre><code class="lang-csharp hljs">public void Update()</code></pre>
  </div>
  <h5 id="netDxf_Entities_HatchBoundaryPath_Update_remarks">Remarks</h5>
  <div class="markdown level1 remarks"><p>It is necessary to manually call this method when changes to the boundary entities are made. This is only applicable to associative hatches,
non-associative hatches has no associated boundary entities.</p>
</div>
  <h3 id="implements">Implements</h3>
  <div>
      <span class="xref">System.ICloneable</span>
  </div>
</article>
          </div>
          
          <div class="hidden-sm col-md-2" role="complementary">
            <div class="sideaffix">
              <div class="contribution">
                <ul class="nav">
                  <li>
                    <a href="https://github.com/SOFAgh/CADability/new/master/apiSpec/new?filename=netDxf_Entities_HatchBoundaryPath.md&amp;value=---%0Auid%3A%20netDxf.Entities.HatchBoundaryPath%0Asummary%3A%20'*You%20can%20override%20summary%20for%20the%20API%20here%20using%20*MARKDOWN*%20syntax'%0A---%0A%0A*Please%20type%20below%20more%20information%20about%20this%20API%3A*%0A%0A" class="contribution-link">Improve this Doc</a>
                  </li>
                  <li>
                    <a href="https://github.com/SOFAgh/CADability/blob/master/CADability/DXF/Entities/HatchBoundaryPath.cs/#L39" class="contribution-link">View Source</a>
                  </li>
                </ul>
              </div>
              <nav class="bs-docs-sidebar hidden-print hidden-xs hidden-sm affix" id="affix">
                <h5>In This Article</h5>
                <div></div>
              </nav>
            </div>
          </div>
        </div>
      </div>
      
      <footer>
        <div class="grad-bottom"></div>
        <div class="footer">
          <div class="container">
            <span class="pull-right">
              <a href="#top">Back to top</a>
            </span>
            
            <span>Generated by <strong>DocFX</strong></span>
          </div>
        </div>
      </footer>
    </div>
    
    <script type="text/javascript" src="../styles/docfx.vendor.js"></script>
    <script type="text/javascript" src="../styles/docfx.js"></script>
    <script type="text/javascript" src="../styles/main.js"></script>
  </body>
</html>
